Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PoC: public transaction notes #4693

Draft
wants to merge 5 commits into
base: dev
Choose a base branch
from
Draft

PoC: public transaction notes #4693

wants to merge 5 commits into from

Conversation

katspaugh
Copy link
Member

@katspaugh katspaugh commented Dec 19, 2024

What it solves

This PR hijacks the origin.name field in proposed transactions to attach a custom note to a tx. To avoid collisions with actual Safe App names used for this purpose, the note is encoded as JSON.

The note is then retrieved from the tx-service's origin field and JSON-parsed.

Adding a note:
Screenshot 2024-12-19 at 14 01 53
from the transaction service from the origin field in TransactionDetails.

Displaying a note:
Screenshot 2024-12-19 at 13 59 14

Copy link

github-actions bot commented Dec 19, 2024

Copy link

github-actions bot commented Dec 19, 2024

Coverage report

St.
Category Percentage Covered / Total
🟡 Statements
74.02% (-0.07% 🔻)
14584/19704
🔴 Branches
51.57% (-0.06% 🔻)
3470/6729
🔴 Functions
57% (-0.07% 🔻)
2063/3619
🟡 Lines
75.56% (-0.07% 🔻)
13229/17509
Show new covered files 🐣
St.
File Statements Branches Functions Lines
🔴
... / TxNote.tsx
28% 0% 0% 31.82%
🔴
... / TxNoteForm.tsx
57.14% 50% 50% 53.85%
Show files with reduced coverage 🔻
St.
File Statements Branches Functions Lines
🟢
... / SignOrExecuteForm.tsx
90.91% (-2.15% 🔻)
86.11% (-2.29% 🔻)
42.86% (-7.14% 🔻)
90.41% (-2.24% 🔻)
🟢
... / useTxPendingStatuses.ts
77.5% (-0.83% 🔻)
64.06% (-1.56% 🔻)
68.18%
86.41% (-0.97% 🔻)

Test suite run success

1752 tests passing in 237 suites.

Report generated by 🧪jest coverage report action from 96a1684

Copy link

github-actions bot commented Dec 19, 2024

📦 Next.js Bundle Analysis for safe-wallet-web

This analysis was generated by the Next.js Bundle Analysis action. 🤖

⚠️ Global Bundle Size Increased

Page Size (compressed)
global 1012.91 KB (🟡 +291 B)
Details

The global bundle is the javascript bundle that loads alongside every page. It is in its own category because its impact is much higher - an increase to its size means that every page on your website loads slower, and a decrease means every page loads faster.

Any third party scripts you have added directly to your app using the <script> tag are not accounted for in this analysis

If you want further insight into what is behind the changes, give @next/bundle-analyzer a try!

Seven Pages Changed Size

The following pages changed size from the code in this PR compared to its base branch:

Page Size (compressed) First Load
/apps/open 53.61 KB (-1 B) 1.04 MB
/transactions 96.57 KB (-1 B) 1.08 MB
/transactions/history 96.53 KB (-1 B) 1.08 MB
/transactions/messages 58.3 KB (-1 B) 1.05 MB
/transactions/msg 54.55 KB (-1 B) 1.04 MB
/transactions/queue 47.4 KB (-1 B) 1.04 MB
/transactions/tx 46.76 KB (-1 B) 1.03 MB
Details

Only the gzipped size is provided here based on an expert tip.

First Load is the size of the global bundle plus the bundle for the individual page. If a user were to show up to your website and land on a given page, the first load size represents the amount of javascript that user would need to download. If next/link is used, subsequent page loads would only need to download that page's bundle (the number in the "Size" column), since the global bundle has already been downloaded.

Any third party scripts you have added directly to your app using the <script> tag are not accounted for in this analysis

Next to the size is how much the size has increased or decreased compared with the base branch of this PR. If this percentage has increased by 20% or more, there will be a red status indicator applied, indicating that special attention should be given to this.


const [data] = useAsync(() => {
if (!safeTxHash || !txService) return
return fetch(`${txService}/api/v1/multisig-transactions/${safeTxHash}`).then((res) => res.json())
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm using the tx-service directly here because CGW doesn't mirror the origin field. It can be easily added there.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant